Introduction
Welcome to the Alaunus API! You can use our API to access Alaunus API endpoints, which can get information on stuff in our database.
We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
Authentication
To authorize, use this code:
require 'Kittn'
api = Kittn::APIClient.authorize!('meowmeowmeow')
import kittn
api = kittn.authorize('meowmeowmeow')
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
-H "Authorization: meowmeowmeow"
const kittn = require('kittn');
let api = kittn.authorize('meowmeowmeow');
Make sure to replace
meowmeowmeowwith your API key.
Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our developer portal.
Kittn expects for the API key to be included in all API requests to the server in a header that looks like the following:
Authorization: meowmeowmeow
Query
Queries
(show more)
(show more)
>, >=, <, <=, !=
(show more)
$nin: passes if the document's value is not equal to any of the query's values for the field
(show more)
(show more)
$and: passes if all of the subqueries pass
$not: inverts the result of the subqueries
$nor: passes if none of the subqueries pass
(show more)
- the fields of the subqueries are the subfields of field
- the outer field must be of type subdocuments or array
(show more)
- this is useful for partial string matching
- for the given example, value "and" accepts names like "Andrew", "Sandy", "Ferdinand", ...
- "$options":"i" means case insensitive
- there are other options: m, x, s
- refer to mongodb
Accounts
The accounts object
Attributes:
integer
subdocument
subdocument
string
subdocuments
string
string
subdocument
subdocuments
file
subdocument
subdocument
file
subdocument
subdocuments
subdocuments
subdocument
subdocuments
subdocument
subdocuments
subdocument
subdocuments
subdocument
string
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"auth": {
"access_token": "JDJhJDEwJDZucU9qVDEvVXo3dFlvNXk3b2NOR0...",
"access_secret": "VTJGc2RHVmtYMS91TDRQWTZxeE5LTWJPZ0xka...",
"access_key": "VTJGc2RHVmtYMSs4cjJqUlAxckxxRDV2NUN4Uk14..."
},
"user": {
"_id": "57360e77f90e15c27c8b4567",
"ext_id": "6O0482C",
"last_login_date": "2016-11-08T15:37:29-05:00",
"pin_lastchanged_date": "2016-05-13T13:36:44-04:00",
"date_of_birth": "1983-05-17",
"locations": [
{
"_created_user": {
"_id": "5679cdb609da69d90c8b4577",
"ext_id": "BNUWU93",
"email": "iegor.benzyk2@alaunus.com",
"name": {
"first": "Isaac",
"last": "Romanov",
"title": "2e5c84ad927c053c8b7a7657"
}
},
"address": {
"street": "151 Charles St W",
"city": "Kitchener",
"lat": 43.4509381,
"lng": -80.4982637,
"country": "29f678bca33e6a07d9d61066",
"state": "baa39fa80fb2f0bbf4d8cfdf"
},
"primary": true,
"type": "3f5aa337cc7338b01f435787",
"_id": "5736124ef90e15c37c8b456c",
"_key": 0
}
],
"is_recover": true
},
"stage": "dev",
"version": "1.4.5"
}
Create accounts
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit accounts
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete accounts
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get account
Gets the details of an existing account. Supply the unique account ID from either a account creation request or the account list, and Alaunus will return the corresponding account information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List accounts
Returns a list of existing accounts sent to third-party bank accounts or that Alaunus has sent you. The accounts are returned in sorted order, with the most recently created accounts appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Candidates
The candidates object
Attributes:
subdocuments
boolean
datetime
id
subdocument
subdocuments
subdocuments
string
boolean
string
date
string
subdocuments
subdocument
string
id
boolean
boolean
subdocuments
subdocuments
id
subdocument
string
subdocuments
integer
string
subdocument
subdocuments
id
boolean
id
boolean
boolean
id
subdocument
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"_id": "57bb51926de3adca448b456c",
"candidate_status": "f577a1a7ca2e3da7c4e5d509",
"email": "carol.fuji@alaunus.com",
"rating": 1,
"_account": {
"_id": "53f6aa644d2de64fb30000af",
"candidate_settings": {
"submit_id": "6d54f4fa69cc90efa35d9ac3",
"is_hiring": true,
"candidate_stages": [
{
"_id": "8a0a81c9d3ac2a850d05a1a9",
"code": "applied",
"color": "#919191",
"label": "Applied",
"order": 0,
"_key": 0
},
{
"color": "#6699ff",
"label": "Phone Screened",
"order": 1,
"_id": "a8afc802b406cbb465019cb3",
"code": "phone",
"_key": 1
},
{
"order": 2,
"_id": "b9901f6a469fceb28b9759c5",
"code": "interview",
"color": "#009999",
"label": "Selected for Interview",
"_key": 2
},
{
"_id": "f577a1a7ca2e3da7c4e5d509",
"code": "other",
"color": "#009933",
"label": "Interviewed",
"order": 3,
"_key": 3
}
],
"request_id": "49db79f2b33c237eac6bdc26"
}
},
"ext_id": "KVLA02F",
"experience_with_ages": {
"age_0_months_3_months": false,
"age_3_months_1_year": false,
"age_1_year_3_years": false,
"age_3_years_6_years": false,
"age_6_years_10_years": false,
"age_10_years_15_years": false,
"age_15_years_more": false
},
"criminal_offender": true,
"work_permit": "30afd55e70f46110f468034c",
"_schema": "55b12234599748249a5b3341",
"_created_date": "2016-08-22T15:25:06-04:00",
"availability": {
"mon": [
{
"start": 0,
"end": 1440,
"_id": "57e875924c120cc7018b456e",
"_key": 0
}
],
"tue": [
{
"start": 0,
"end": 1440,
"_id": "57e875924c120cc7018b456f",
"_key": 0
}
],
"wed": [
{
"start": 0,
"end": 1440,
"_id": "57e875924c120cc7018b4570",
"_key": 0
}
],
"thu": [
{
"start": 0,
"end": 1440,
"_id": "57e875924c120cc7018b4571",
"_key": 0
}
],
"fri": [
{
"start": 0,
"end": 1440,
"_id": "57e875924c120cc7018b4572",
"_key": 0
}
],
"sat": [
{
"start": 0,
"end": 1440,
"_id": "57e875924c120cc7018b4573",
"_key": 0
}
],
"sun": [
{
"start": 0,
"end": 1440,
"_id": "57e875924c120cc7018b4574",
"_key": 0
}
]
},
"travel_passport": false,
"living_status": "14063fd9ce471eb4a89e8efb",
"us_visa": false,
"is_smoker": false,
"has_pets": false,
"phones": [
{
"country": "29f678bca33e6a07d9d61066",
"number": "+15585451132",
"_id": "57bb51926de3adca448b456a",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"primary": true,
"_key": 0
}
],
"will_travel": false,
"date_of_birth": "1989-11-16",
"name": {
"first": "Caroline",
"last": "Fuji"
},
"locations": [
{
"address": {
"lat": 43.6152684,
"lng": -79.7098497,
"country": "29f678bca33e6a07d9d61066",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"street": "834 Mays Crescent",
"city": "Mississauga",
"zip": "L5V2G6"
},
"primary": true,
"_id": "57bb51926de3adca448b456b",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"_key": 0
}
],
"work_status": {
"temp": false,
"on_call": false,
"full_time": false,
"part_time": false
}
}
Create candidates
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit candidates
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete candidates
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get candidate
Gets the details of an existing candidate. Supply the unique candidate ID from either a candidate creation request or the candidate list, and Alaunus will return the corresponding candidate information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List candidates
Returns a list of existing candidates sent to third-party bank accounts or that Alaunus has sent you. The candidates are returned in sorted order, with the most recently created candidates appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Clients
The clients object
Attributes:
string
string
subdocument
subdocument
id
string
subdocuments
string
subdocuments
id
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"_id": "53f6b931ccdf0519510000fe",
"_created_date": "2014-06-22T04:25:42-04:00",
"ext_id": "X93FR",
"accounting_id": "X93FR",
"employees": [
{
"name": {
"title": "2e5c84ad927c053c8b7a7657",
"first": "Anderson",
"last": "Smith"
},
"office": {
"address": {
"state": "baa39fa80fb2f0bbf4d8cfdf",
"lat": 43.8076048,
"lng": -79.3381626,
"street": "3650 Victoria Avenue",
"country": "29f678bca33e6a07d9d61066",
"street_extra": "9th Floor",
"city": "North York",
"zip": "M2H3P7"
},
"_id": "53bc6f33f918f12387000000",
"_created_user": "53a8701dd6c8df514f8b459d",
"title": "North York Location",
"_key": 0
},
"_created_user": "53a8701dd6c8df514f8b459d",
"phone": {
"country": "29f678bca33e6a07d9d61066",
"number": "+16359961547"
},
"email": "anderson.smith@alaunus.com",
"_id": "54bd355e6fe5165c1700005e",
"ext_id": "YTQX87S",
"_key": 0
}
],
"color": "#3CBB3A",
"_account": "53f6aa644d2de64fb30000af",
"type": "518bffa09c79e9cd0f2fbc82",
"contact_type": "537117bbf518db6e5202a33c",
"company": {
"name": {
"title": "TD General Insurance Company"
}
},
"locations": [
{
"address": {
"state": "baa39fa80fb2f0bbf4d8cfdf",
"lat": 43.8076048,
"lng": -79.3381626,
"street": "3650 Victoria Avenue",
"country": "29f678bca33e6a07d9d61066",
"street_extra": "9th Floor",
"city": "North York",
"zip": "M2H3P7"
},
"_id": "53bc6f33f918f12387000000",
"_created_user": "53a8701dd6c8df514f8b459d",
"title": "North York Location",
"_key": 0
},
{
"address": {
"street_extra": "4th Floor",
"city": "Toronto",
"zip": "M4S3A6",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"lat": 43.7043681,
"lng": -79.3978194,
"street": "2161 Yonge Street",
"country": "29f678bca33e6a07d9d61066"
},
"_id": "53bc6f33f918f12387000001",
"_created_user": "53a8701dd6c8df514f8b459d",
"title": "Toronto Location",
"_key": 1
},
{
"_created_user": "53a8701dd6c8df514f8b459d",
"title": "Burlington Location",
"address": {
"country": "29f678bca33e6a07d9d61066",
"street_extra": "Suite 100",
"city": "Burlington",
"zip": "L7Y5Y7",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"lat": 43.3809104,
"lng": -79.7698832,
"street": "5045 South Service Road"
},
"_id": "53bc6f33f918f12387000002",
"_key": 2
}
]
}
Create clients
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit clients
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete clients
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get client
Gets the details of an existing client. Supply the unique client ID from either a client creation request or the client list, and Alaunus will return the corresponding client information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List clients
Returns a list of existing clients sent to third-party bank accounts or that Alaunus has sent you. The clients are returned in sorted order, with the most recently created clients appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Contacts
The contacts object
Attributes:
id
string
subdocument
subdocument
string
string
subdocument
subdocuments
string
file
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"_id": "573f2b84f90e15421b8b456a",
"accounting_id": "HOUSE",
"company": {
"name": {
"title": "House"
}
},
"_schema": "55b122aa599748249a5b3380",
"ext_id": "HOUSE",
"_type": "537117bbf518db6e5202a33c",
"_account": "53f6aa644d2de64fb30000af",
"_created_date": "2016-05-20T11:21:40-04:00"
}
Create contacts
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit contacts
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete contacts
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get contact
Gets the details of an existing contact. Supply the unique contact ID from either a contact creation request or the contact list, and Alaunus will return the corresponding contact information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List contacts
Returns a list of existing contacts sent to third-party bank accounts or that Alaunus has sent you. The contacts are returned in sorted order, with the most recently created contacts appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Conversations
The conversations object
Attributes:
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"_id": "575042e0f90e15f24e8b456b",
"messages": {
"575042e0f90e15f24e8b4569": {
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"phones": [
{
"number": "+18888881111;ext=123",
"_id": "57361284f90e15957c8b4569",
"_created_user": "5679cdb609da69d90c8b4577",
"primary": true,
"country": "29f678bca33e6a07d9d61066",
"type": "3a9158c55c954ed42dad0861",
"_key": 0
}
],
"name": {
"first": "John",
"last": "Doe"
}
},
"message": "Hey - are you able to take 3pm shift?",
"from": {
"_id": "57360e77f90e15c27c8b4567",
"phones": [
{
"number": "+18888881111;ext=123",
"_id": "57361284f90e15957c8b4569",
"_created_user": "5679cdb609da69d90c8b4577",
"primary": true,
"country": "29f678bca33e6a07d9d61066",
"type": "3a9158c55c954ed42dad0861",
"_key": 0
}
],
"name": {
"first": "John",
"last": "Doe"
}
},
"sent_date": "2016-06-02T10:29:52-04:00",
"_id": "575042e0f90e15f24e8b4569",
"_key": 0
}
},
"to": {
"575042e0f90e15f24e8b456a": {
"user": {
"_id": "53f6b78f6396a09753000074",
"phones": [
{
"primary": true,
"country": "29f678bca33e6a07d9d61066",
"type": "3a9158c55c954ed42dad0861",
"number": "+14555124587",
"_id": "57bb44ac6de3ad2e428b45b1",
"_created_user": "57360e77f90e15c27c8b4567",
"_key": 0
}
],
"photo": "53f6b78f6396a09753000073",
"name": {
"first": "Ramona",
"last": "Turner"
}
},
"archived": false,
"flag": false,
"_id": "575042e0f90e15f24e8b456a",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"phones": [
{
"number": "+18888881111;ext=123",
"_id": "57361284f90e15957c8b4569",
"_created_user": "5679cdb609da69d90c8b4577",
"primary": true,
"country": "29f678bca33e6a07d9d61066",
"type": "3a9158c55c954ed42dad0861",
"_key": 0
}
],
"name": {
"first": "John",
"last": "Doe"
}
},
"_key": 0
}
},
"_account": "53f6aa644d2de64fb30000af",
"_schema": "55b122a3599748249a5b337d",
"_created_date": "2016-06-02T10:29:52-04:00",
"from": {
"user": {
"_id": "57360e77f90e15c27c8b4567",
"phones": [
{
"number": "+18888881111;ext=123",
"_id": "57361284f90e15957c8b4569",
"_created_user": "5679cdb609da69d90c8b4577",
"primary": true,
"country": "29f678bca33e6a07d9d61066",
"type": "3a9158c55c954ed42dad0861",
"_key": 0
}
],
"name": {
"first": "John",
"last": "Doe"
}
},
"archived": false,
"flag": false
}
}
Create conversations
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit conversations
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete conversations
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get conversation
Gets the details of an existing conversation. Supply the unique conversation ID from either a conversation creation request or the conversation list, and Alaunus will return the corresponding conversation information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List conversations
Returns a list of existing conversations sent to third-party bank accounts or that Alaunus has sent you. The conversations are returned in sorted order, with the most recently created conversations appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Events
The events object
Attributes:
id
datetime
subdocuments
subdocument
float
datetime
subdocument
subdocument
subdocument
string
subdocument
subdocument
datetime
boolean
id
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"meta": {
"start": "2016-05-16T04:00:00+00:00",
"end": "2016-05-25T03:59:59+00:00",
"visits": {
"filtered": 0,
"total": 0
},
"duration": {
"filtered": 0
},
"resource": "patients",
"group": "patients"
},
"data": [
],
"resource": {
"57360e2cf90e15a37b8b45de": {
"_id": "57360e2cf90e15a37b8b45de"
},
"53f6e9ba52b53f0b300005fc": {
"_id": "53f6e9ba52b53f0b300005fc"
},
"53f6e8dd52b53fdb3100023c": {
"_id": "53f6e8dd52b53fdb3100023c"
},
"575acaaaf90e1582768b458b": {
"_id": "575acaaaf90e1582768b458b"
},
"53f6e92852b53f0b30000444": {
"_id": "53f6e92852b53f0b30000444"
},
"53f6e91652b53f0b30000418": {
"_id": "53f6e91652b53f0b30000418"
}
},
"resources": {
"users": {
"57a8ca9d7e00026e298b456c": {
"_id": "57a8ca9d7e00026e298b456c",
"role": "5398cbd8888e52e485000146",
"ext_id": "67KJH48",
"name": {
"last": "Verma",
"first": "Amandeep"
}
},
"5679cdb609da69d90c8b4577": {
"_id": "5679cdb609da69d90c8b4577",
"ext_id": "BNUWU93",
"role": "5398cbd8888e52e485000145",
"name": {
"first": "Isaac",
"last": "Romanov",
"title": "2e5c84ad927c053c8b7a7657"
}
},
"57360e77f90e15c27c8b4567": {
"_id": "57360e77f90e15c27c8b4567",
"ext_id": "6O0482C",
"role": "5398cbd8888e52e485000146",
"name": {
"first": "John",
"last": "Doe"
}
}
},
"locations": [
{
"country": "29f678bca33e6a07d9d61066",
"city": "Kitchener",
"state": "baa39fa80fb2f0bbf4d8cfdf"
},
{
"country": "29f678bca33e6a07d9d61066",
"city": "Toronto",
"state": "baa39fa80fb2f0bbf4d8cfdf"
},
{
"country": "29f678bca33e6a07d9d61066",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"city": "Bolton"
},
{
"country": "29f678bca33e6a07d9d61066",
"city": "Brampton",
"state": "baa39fa80fb2f0bbf4d8cfdf"
},
{
"country": "29f678bca33e6a07d9d61066",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"city": "Markham"
},
{
"country": "29f678bca33e6a07d9d61066",
"city": "Milton",
"state": "baa39fa80fb2f0bbf4d8cfdf"
},
{
"state": "baa39fa80fb2f0bbf4d8cfdf",
"country": "29f678bca33e6a07d9d61066",
"city": "Thornhill"
},
{
"state": "baa39fa80fb2f0bbf4d8cfdf",
"country": "29f678bca33e6a07d9d61066",
"city": "North York"
},
{
"country": "29f678bca33e6a07d9d61066",
"city": "Mississauga",
"state": "baa39fa80fb2f0bbf4d8cfdf"
},
{
"city": "Kitchner",
"country": "29f678bca33e6a07d9d61066",
"state": "baa39fa80fb2f0bbf4d8cfdf"
},
{
"country": "29f678bca33e6a07d9d61066",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"city": "Waterloo"
}
]
}
}
Create events
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit events
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete events
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get event
Gets the details of an existing event. Supply the unique event ID from either a event creation request or the event list, and Alaunus will return the corresponding event information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List events
Returns a list of existing events sent to third-party bank accounts or that Alaunus has sent you. The events are returned in sorted order, with the most recently created events appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Eventsgroups
The eventsgroups object
Attributes:
array
array
integer
date
datetime
subdocument
array
string
integer
datetime
datetime
string
curl 'http://example.com/api/test'
-H 'Authorization: key'
[
{
"_id": "573f6ad5f90e153e1d8b4577",
"end": "2016-05-03T12:00:00-04:00",
"duration": 7200,
"_group": "573f6ad4f90e153e1d8b4576",
"start": "2016-05-03T10:00:00-04:00",
"attendees": [
{
"user": {
"name": {
"last": "Simmons",
"first": "Jeanne"
}
},
"_id": "573f6ad5f90e153e1d8b457d",
"_key": 0
}
],
"status": "a7f2da8ce2f36c258fb83d90",
"_deleted": false
},
{
"_id": "573f6ad5f90e153e1d8b4578",
"duration": 7200,
"status": "a7f2da8ce2f36c258fb83d90",
"attendees": [
{
"user": {
"name": {
"first": "Jeanne",
"last": "Simmons"
}
},
"_id": "573f6ad5f90e153e1d8b457e",
"_key": 0
}
],
"_group": "573f6ad4f90e153e1d8b4576",
"end": "2016-05-05T12:00:00-04:00",
"start": "2016-05-05T10:00:00-04:00",
"_deleted": false
},
{
"_id": "573f6ad5f90e153e1d8b4579",
"status": "a7f2da8ce2f36c258fb83d90",
"duration": 7200,
"end": "2016-05-10T12:00:00-04:00",
"_group": "573f6ad4f90e153e1d8b4576",
"start": "2016-05-10T10:00:00-04:00",
"attendees": [
{
"_id": "573f6ad5f90e153e1d8b457f",
"user": {
"name": {
"last": "Simmons",
"first": "Jeanne"
}
},
"_key": 0
}
],
"_deleted": false
},
{
"_id": "573f6ad5f90e153e1d8b457a",
"start": "2016-05-12T10:00:00-04:00",
"end": "2016-05-12T12:00:00-04:00",
"attendees": [
{
"user": {
"name": {
"first": "Jeanne",
"last": "Simmons"
}
},
"_id": "573f6ad5f90e153e1d8b4580",
"_key": 0
}
],
"duration": 7200,
"_group": "573f6ad4f90e153e1d8b4576",
"status": "ace1a822daf25bfeb38a30d4",
"_deleted": false
},
{
"_id": "573f6ad5f90e153e1d8b457b",
"_group": "573f6ad4f90e153e1d8b4576",
"attendees": [
{
"user": {
"name": {
"first": "Jeanne",
"last": "Simmons"
}
},
"_id": "573f6ad5f90e153e1d8b4581",
"_key": 0
}
],
"status": "a7f2da8ce2f36c258fb83d90",
"start": "2016-05-17T10:00:00-04:00",
"end": "2016-05-17T12:00:00-04:00",
"duration": 7200,
"_deleted": false
},
{
"_id": "573f6ad5f90e153e1d8b457c",
"status": "ace1a822daf25bfeb38a30d4",
"attendees": [
{
"user": {
"name": {
"first": "Jeanne",
"last": "Simmons"
}
},
"_id": "573f6ad5f90e153e1d8b4582",
"_key": 0
}
],
"duration": 7200,
"end": "2016-05-19T12:00:00-04:00",
"_group": "573f6ad4f90e153e1d8b4576",
"start": "2016-05-19T10:00:00-04:00",
"_deleted": false
}
]
Create eventsgroups
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit eventsgroups
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete eventsgroups
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get eventsgroup
Gets the details of an existing eventsgroup. Supply the unique eventsgroup ID from either a eventsgroup creation request or the eventsgroup list, and Alaunus will return the corresponding eventsgroup information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List eventsgroups
Returns a list of existing eventsgroups sent to third-party bank accounts or that Alaunus has sent you. The eventsgroups are returned in sorted order, with the most recently created eventsgroups appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Files
The files object
Attributes:
datetime
string
string
string
string
string
id
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"file": "file.pdf",
"type": "575042e0f90e15f24e8b456b",
"name": "Mikael's resume",
"_uploaded_date": "15/04/1451",
"content_type": "pdf",
"checksum": "A6F4DS8sa2f316FDA3as1ADSA465fd1s3v1a6dsa1DF4SAdsa1fd65SF"
}
Create files
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit files
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete files
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get file
Gets the details of an existing file. Supply the unique file ID from either a file creation request or the file list, and Alaunus will return the corresponding file information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List files
Returns a list of existing files sent to third-party bank accounts or that Alaunus has sent you. The files are returned in sorted order, with the most recently created files appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Invoices
The invoices object
Attributes:
boolean
datetime
id
subdocument
float
float
subdocument
subdocument
string
subdocument
id
date
string
string
string
string
date
id
string
date
id
string
string
subdocument
subdocuments
subdocument
subdocument
subdocuments
id
float
float
subdocuments
id
subdocument
float
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"_id": "573f343af90e15011b8b4576",
"status": "3aad821f389be2ad5dd2f72f",
"currency": "158fd9fea21be1043f5f3118",
"number": "A000000103",
"billing_period_start_date": "2016-05-02",
"amount_paid": 0,
"template": "5361bcbc695af3e0a9634341",
"invoice_type": "7e1a564dfadc3bd13b251d69",
"payment_method": "3bd8f8b09e49ee5ebc42eea5",
"from_email": "support@alaunus.com",
"footer_message": "Thank you for your business. Please send payment...",
"due_date": "2016-07-01",
"_created_date": "2016-05-20T11:58:50-04:00",
"cc_invoice": {
"patient": false
},
"amount_due": 100,
"services": [
{
"hours": {
"actual": 28860,
"bill": 14400,
"pay": 28860,
"scheduled": 28800
},
"label": "Attendant Care",
"_service": "536f3444f518db6e5202a32c",
"description": "Attendant Care: 5/1/2016 - 5/31/2016",
"bill_rate": {
"rate": 25,
"unit": "2c39fd62449c8da26b9b09ac"
},
"total": 100,
"_created_user": "57360e77f90e15c27c8b4567",
"amount": 4,
"punchcards": [
"573e318cf90e1588188b4567",
"573f3469f90e15791b8b457a",
"573e32c4f90e15cf178b4573",
"573f6b69f90e154d1d8b4570"
],
"code": "AC001",
"color": "#00aa00",
"_id": "573f343af90e15011b8b4575",
"_key": 0
}
],
"legal_rep": "Ivan Boyko",
"method": "35f16131a2aa09285decbb09",
"term": {
"_term": "536f311aaa78d2940c0000f7",
"term": 30,
"label": "NET 30"
},
"billing_period_end_date": "2016-06-01",
"billing_period": {
"period": "f44aaeb99e21a2ea93134762",
"day": 1
},
"_account": "53f6aa644d2de64fb30000af",
"invoice_date": "2016-06-01",
"subtotal": 100,
"tax_total": 0,
"total": 100,
"account": {
"name": {
"title": "Acme Health Services"
},
"website": "www.alaunus.com",
"location": {
"_location": "54655d0e52b53f2579000d5a",
"title": "Toronto Office",
"phone": {
"country": "29f678bca33e6a07d9d61066",
"number": "+19058760572"
},
"fax": {
"country": "29f678bca33e6a07d9d61066",
"number": "+19058764293"
},
"address": {
"street": "123 King Street",
"city": "Toronto",
"country": "29f678bca33e6a07d9d61066",
"state": "baa39fa80fb2f0bbf4d8cfdf"
}
},
"_account": "53f6aa644d2de64fb30000af"
},
"_schema": "56e10982199748249ab9f007"
}
Create invoices
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit invoices
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete invoices
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get invoice
Gets the details of an existing invoice. Supply the unique invoice ID from either a invoice creation request or the invoice list, and Alaunus will return the corresponding invoice information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List invoices
Returns a list of existing invoices sent to third-party bank accounts or that Alaunus has sent you. The invoices are returned in sorted order, with the most recently created invoices appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Patients
The patients object
Attributes:
id
subdocuments
string
subdocuments
subdocument
string
subdocument
subdocuments
date
string
id
subdocument
subdocuments
id
string
boolean
string
boolean
subdocuments
string
subdocuments
string
subdocument
subdocuments
subdocuments
file
subdocuments
id
id
subdocument
subdocument
subdocuments
string
date
id
boolean
id
boolean
boolean
subdocument
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"_id": "57360e2cf90e15a37b8b45de",
"problems": [
{
"onset_date": "1992-08-18T00:00:00-04:00",
"_id": "57b7405c6de3adb83e8b4570",
"diagnosis_date": "2000-08-14T00:00:00-04:00",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"notes": "Needs special care",
"status": "29958791d23f7ab777b157a7",
"problem": "Dementia",
"type": "977f988337dbd6bbeff038fe",
"_key": 2
}
],
"name": {
"first": "Alex",
"last": "Snow",
"title": "2e5c84ad927c053c8b7a7657"
},
"has_pets": true,
"education_level": "26cb098b51ca13cc095579a9",
"living_status": "14063fd9ce471eb4a89e8efb",
"experience_num_of_years": "576b0816efa3eedd9ff0368b",
"type_of_pets": "576b1dc8efa3eedd9ff0369c",
"billing": [
],
"locations": [
{
"address": {
"country": "29f678bca33e6a07d9d61066",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"street": "12 Rosedale Ave",
"city": "Kitchener",
"zip": "N2H1J3",
"lat": 43.443177,
"lng": -80.4683897,
"map_img": "https://maps.google.com/maps/api/stati..."
},
"primary": true,
"type": "235a44f0aafaf29a9695a9d3",
"_id": "57360e2cf90e15a37b8b45d2",
"_created_user": {
"_id": "5679cdb609da69d90c8b4577",
"name": {
"first": "Isaac",
"last": "Romanov",
"title": "2e5c84ad927c053c8b7a7657"
}
},
"_key": 0
}
],
"_account": {
"_id": "53f6aa644d2de64fb30000af",
"sales_reps": {
"54bd36371b6d0201298b45cc": {
"_id": "54bd36371b6d0201298b45cc",
"ext_id": "BIUT7IF",
"name": {
"title": "434939d5fe339e26bbb2d3da",
"first": "Jane",
"last": "Smith"
},
"office": "54655d0e52b53f2579000d5a",
"_created_user": "53a8701dd6c8df514f8b459d",
"_key": 0
},
"573f2b9ef90e15421b8b456b": {
"office": "54655d0e52b53f2579000d5a",
"_id": "573f2b9ef90e15421b8b456b",
"_created_user": "57360e77f90e15c27c8b4567",
"ext_id": "H9JTU0O",
"accounting_id": "H9JTU0O",
"name": {
"last": "Ratcliff",
"first": "Daniel"
},
"_key": 1
}
}
},
"_schema": "55b1226b599748249a5b335d",
"experience_with_ages": {
"age_0_months_3_months": false,
"age_3_months_1_year": false,
"age_1_year_3_years": false,
"age_3_years_6_years": false,
"age_6_years_10_years": false,
"age_10_years_15_years": false,
"age_15_years_more": false
},
"status": "3827d82b69c28220db67763d",
"email": "alex.snow14@alaunus.com",
"marital_status": "4ac5f4d009ef4dad678b1323",
"travel_passport": false,
"date_of_birth": "1962-08-17",
"legal_rep": "Ivan Boyko",
"languages": [
{
"primary": true,
"language": "318722ea904dbe2ec1abc659",
"fluency": "1cc5a6123c0bebd535e5a6ee",
"_id": "57360e2cf90e15a37b8b45d5",
"_created_user": {
"_id": "5679cdb609da69d90c8b4577",
"name": {
"first": "Isaac",
"last": "Romanov",
"title": "2e5c84ad927c053c8b7a7657"
}
},
"_key": 0
}
],
"user_education_level": "18491510e5a178535163b910",
"cleaning_skill": "576b23abefa3eedd9ff036a8",
"accounting_id": "R44RERF",
"religion": "03b630f6212a425cf9f34134",
"general_notes": "Keys under carpet. Client needs assistance bathing.",
"files": [
],
"will_travel": false,
"case_coordinator": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"ethnicity": "22ec511204f16a70e0bd02fd",
"contacts": [
{
"_created_user": {
"_id": "5679cdb609da69d90c8b4577",
"name": {
"first": "Isaac",
"last": "Romanov",
"title": "2e5c84ad927c053c8b7a7657"
}
},
"emergency": true,
"name": "Jack Novel",
"relationship": "Friend",
"phones": [
{
"_created_user": {
"_id": "5679cdb609da69d90c8b4577",
"name": {
"first": "Isaac",
"last": "Romanov",
"title": "2e5c84ad927c053c8b7a7657"
}
},
"primary": true,
"country": "29f678bca33e6a07d9d61066",
"type": "4d781246adf865e9e117968b",
"number": "+12063364572",
"_id": "57360e2cf90e15a37b8b45d3",
"_key": 57360
}
],
"_id": "57360e2cf90e15a37b8b45d4",
"_key": 0
}
],
"cooking_skill": "576b1e8fefa3eedd9ff036a1",
"chart_id": "R44RERF",
"gender": "388057a478772ba4b477d1d7",
"services": [
{
"service": "536f3444f518db6e5202a32c",
"max_billables": {
"month": {
"dollars": 5548.83
},
"contract": {
"dollars": 36000
}
},
"_id": "57b72e76563de14a3f8b456f",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"invoice_to": {
"type": "518bffa09c79e9cd0f2fbc82",
"client": {
"_id": "53f6b931ccdf0519510000fe",
"employees": {
"54bd355e6fe5165c1700005e": {
"name": {
"title": "2e5c84ad927c053c8b7a7657",
"first": "Anderson",
"last": "Smith"
},
"office": "53bc6f33f918f12387000000",
"_created_user": "53a8701dd6c8df514f8b459d",
"phone": {
"country": "29f678bca33e6a07d9d61066",
"number": "+16359961547"
},
"email": "anderson.smith@alaunus.com",
"_id": "54bd355e6fe5165c1700005e",
"ext_id": "YTQX87S",
"_key": 0
}
},
"contact_type": "537117bbf518db6e5202a33c",
"company": {
"name": {
"title": "TD General Insurance Company"
}
},
"locations": {
"53bc6f33f918f12387000000": {
"address": {
"state": "baa39fa80fb2f0bbf4d8cfdf",
"lat": 43.8076048,
"lng": -79.3381626,
"street": "3650 Victoria Avenue",
"country": "29f678bca33e6a07d9d61066",
"street_extra": "9th Floor",
"city": "North York",
"zip": "M2H3P7"
},
"_id": "53bc6f33f918f12387000000",
"_created_user": "53a8701dd6c8df514f8b459d",
"title": "North York Location",
"_key": 0
},
"53bc6f33f918f12387000001": {
"address": {
"street_extra": "4th Floor",
"city": "Toronto",
"zip": "M4S3A6",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"lat": 43.7043681,
"lng": -79.3978194,
"street": "2161 Yonge Street",
"country": "29f678bca33e6a07d9d61066"
},
"_id": "53bc6f33f918f12387000001",
"_created_user": "53a8701dd6c8df514f8b459d",
"title": "Toronto Location",
"_key": 1
},
"53bc6f33f918f12387000002": {
"_created_user": "53a8701dd6c8df514f8b459d",
"title": "Burlington Location",
"address": {
"country": "29f678bca33e6a07d9d61066",
"street_extra": "Suite 100",
"city": "Burlington",
"zip": "L7Y5Y7",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"lat": 43.3809104,
"lng": -79.7698832,
"street": "5045 South Service Road"
},
"_id": "53bc6f33f918f12387000002",
"_key": 2
}
}
}
},
"take_highest_pay": true,
"bill_rate": {
"rate": 23.95,
"unit": "50ab5c594ef4ae57bda03025",
"taxes": [
{
"tax": "536f3405f518db6e5202a32b",
"_id": "57b72e76563de14a3f8b456e",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"_key": 57
}
]
},
"pay_rate": {
"rate": 13.75,
"unit": "50ab5c594ef4ae57bda03025"
},
"min_billable_hours": 2,
"_key": 1
}
],
"work_status": {
"full_time": false,
"part_time": false,
"temp": false,
"on_call": false
},
"us_visa": false,
"is_smoker": true,
"phones": [
{
"notes": "Call after 5 p.m.",
"number": "+14056286752;ext=11",
"_id": "57360e2cf90e15a37b8b45d1",
"_created_user": {
"_id": "5679cdb609da69d90c8b4577",
"name": {
"first": "Isaac",
"last": "Romanov",
"title": "2e5c84ad927c053c8b7a7657"
}
},
"primary": true,
"country": "29f678bca33e6a07d9d61066",
"type": "4d781246adf865e9e117968b",
"_key": 0
}
],
"_created_date": "2016-05-13T13:26:04-04:00",
"transportation": "576b0594efa3eedd9ff03687"
}
Create patients
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit patients
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete patients
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get patient
Gets the details of an existing patient. Supply the unique patient ID from either a patient creation request or the patient list, and Alaunus will return the corresponding patient information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List patients
Returns a list of existing patients sent to third-party bank accounts or that Alaunus has sent you. The patients are returned in sorted order, with the most recently created patients appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Patientsprogressnotes
The patientsprogressnotes object
Attributes:
datetime
subdocument
subdocument
string
id
id
boolean
id
id
subdocuments
string
subdocuments
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"_id": "57b739937e0002bc408b457e",
"users": {
"57b739937e0002bc408b457d": {
"user": {
"_id": "53f6b74b6396a0d27200004b",
"ext_id": "S1HII3J",
"name": {
"first": "Bernard",
"last": "Rodriguez",
"title": "2e5c84ad927c053c8b7a7657"
},
"photo": "53f6b74b6396a0d27200004a"
},
"_id": "57b739937e0002bc408b457d",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"ext_id": "6O0482C",
"name": {
"first": "John",
"last": "Doe"
}
},
"_key": 0
}
},
"note": "Client called On Call at 5:30pm asking for a PSW...",
"_account": "53f6aa644d2de64fb30000af",
"_last_updated_date": "2016-08-19T14:17:24-04:00",
"priority": "5f13306723ef2a2f494b359c",
"patient": "57360e2cf90e15a37b8b45de",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"ext_id": "6O0482C",
"name": {
"first": "John",
"last": "Doe"
}
},
"tags": {
"57b74d347e0002bc408b457f": {
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"ext_id": "6O0482C",
"name": {
"first": "John",
"last": "Doe"
}
},
"tag": {
"_id": "57b73a617e0002c4408b4576",
"title": "Quality Check"
},
"_id": "57b74d347e0002bc408b457f",
"_key": 0
},
"57b74d347e0002bc408b4580": {
"tag": {
"_id": "57b72d1c6de3adc23e8b4567",
"title": "Shift Cancelation"
},
"_id": "57b74d347e0002bc408b4580",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"ext_id": "6O0482C",
"name": {
"first": "John",
"last": "Doe"
}
},
"_key": 1
},
"57b74d347e0002bc408b4581": {
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"ext_id": "6O0482C",
"name": {
"first": "John",
"last": "Doe"
}
},
"tag": {
"_id": "573f93dbf90e154d1d8b457b",
"title": "Service Change"
},
"_id": "57b74d347e0002bc408b4581",
"_key": 2
}
},
"service": {
"_id": "536f3444f518db6e5202a32c",
"code": "AC001",
"color": "#00aa00",
"_key": 0
},
"invoice_to": {
"client": "53f6b931ccdf0519510000fe",
"type": "518bffa09c79e9cd0f2fbc82"
},
"_schema": "55b12264599748249a5b335a",
"_created_date": "2016-08-19T12:53:39-04:00",
"_last_updated_user": {
"_id": "57360e77f90e15c27c8b4567",
"ext_id": "6O0482C",
"name": {
"first": "John",
"last": "Doe"
}
},
"private": true,
"patient_service": "57b72e76563de14a3f8b456f"
}
Create patientsprogressnotes
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit patientsprogressnotes
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete patientsprogressnotes
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get patientsprogressnote
Gets the details of an existing patientsprogressnote. Supply the unique patientsprogressnote ID from either a patientsprogressnote creation request or the patientsprogressnote list, and Alaunus will return the corresponding patientsprogressnote information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List patientsprogressnotes
Returns a list of existing patientsprogressnotes sent to third-party bank accounts or that Alaunus has sent you. The patientsprogressnotes are returned in sorted order, with the most recently created patientsprogressnotes appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Payments
The payments object
Attributes:
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"amount": "5781.00",
"client": "575042e7q90e15f24e8b456b",
"date": "15/04/1451",
"invoice": "575714e7q90e15f24e8b456b",
"notes": "payment was made early"
}
Create payments
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit payments
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete payments
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get payment
Gets the details of an existing payment. Supply the unique payment ID from either a payment creation request or the payment list, and Alaunus will return the corresponding payment information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List payments
Returns a list of existing payments sent to third-party bank accounts or that Alaunus has sent you. The payments are returned in sorted order, with the most recently created payments appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Payrolls
The payrolls object
Attributes:
boolean
datetime
id
date
integer
id
date
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"_id": "573f6b91f90e15ac1b8b4584",
"_account": "53f6aa644d2de64fb30000af",
"payroll": {
"_id": "5726f997f90e15f2428b45c3",
"start": "2016-05-02",
"end": "2016-06-01"
},
"user": {
"_user": "53f6b4a43fae5b667c000076",
"name": {
"first": "Jeanne",
"last": "Simmons"
},
"services": {
"574fd818f90e151d4d8b4575": {
"pay_rate": {
"rate": 13.12,
"unit": "50ab5c594ef4ae57bda03025"
},
"_service": {
"service": "536f3444f518db6e5202a32c",
"pay_rate": {
"rate": 13.12,
"unit": "50ab5c594ef4ae57bda03025"
},
"_id": "53f6b51795370f425b00007c",
"_key": 0
},
"account_service": "536f3444f518db6e5202a32c",
"code": "AC001",
"color": "#00aa00",
"label": "Attendant Care",
"_id": "574fd818f90e151d4d8b4575",
"_key": 0
},
"574fd818f90e151d4d8b4576": {
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_service": {
"service": "53a37d11056553f52d00000f",
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_id": "53f6b51e3fae5bfa78000084",
"_key": 1
},
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"label": "Registered Practical Nurse",
"_id": "574fd818f90e151d4d8b4576",
"_key": 1
},
"574fd818f90e151d4d8b4577": {
"pay_rate": {
"rate": 31,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_service": {
"service": "536f3627f518db6e5202a32e",
"pay_rate": {
"rate": 31,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_id": "53f6b5263fae5b667c000088",
"_key": 2
},
"account_service": "536f3627f518db6e5202a32e",
"code": "RN001",
"color": "#aa00aa",
"label": "Nursing",
"_id": "574fd818f90e151d4d8b4577",
"_key": 2
},
"574fd818f90e151d4d8b4578": {
"pay_rate": {
"rate": 44,
"unit": "50ab5c594ef4ae57bda03025"
},
"_service": {
"service": "5398cbbdd6d01fec78000039",
"pay_rate": {
"rate": 44,
"unit": "50ab5c594ef4ae57bda03025"
},
"_id": "54008f421c2c61517a8b4843",
"_key": 3
},
"account_service": "5398cbbdd6d01fec78000039",
"code": "RSW001",
"color": "#5484ED",
"label": "Medical Rehab",
"_id": "574fd818f90e151d4d8b4578",
"_key": 3
}
}
},
"punchcards": [
{
"_id": "573f6b91f90e15ac1b8b4583",
"actual": {
"manager": {
"start": "2016-05-17T10:00:00-04:00",
"verified_start": true,
"verified_start_date": "2016-05-20T15:54:57-04:00",
"verified_start_manager": "57360e77f90e15c27c8b4567",
"end": "2016-05-17T12:00:00-04:00",
"verified_end": true,
"verified_end_date": "2016-05-20T15:54:57-04:00",
"verified_end_manager": "57360e77f90e15c27c8b4567"
},
"start": "2016-05-17T10:00:00-04:00",
"end": "2016-05-17T12:00:00-04:00",
"duration": 7200,
"completed": "2016-05-20T15:54:57-04:00"
},
"pay": {
"start": "2016-05-17T10:00:00-04:00",
"end": "2016-05-17T12:00:00-04:00",
"duration": 3600,
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
}
},
"event": "573f6ad5f90e153e1d8b457b",
"_event": {
"duration": 7200,
"_deleted": false
},
"patient": {
"_patient": "53f6e8dd52b53fdb3100023c",
"name": {
"first": "Gabriella",
"last": "Gonzalez"
}
},
"location": {
"address": {
"street": "6440 Copper Falls Ave",
"city": "Thornhill"
}
},
"service": {
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"invoice_to": {
"type": "518bffa09c79e9cd0f2fbc82",
"client": {
"_id": "53f6b9590f0905a1240000f0",
"company": {
"name": {
"title": "State Farm Insurance"
}
}
}
}
},
"payroll": {
"_payroll": "5726f997f90e15f2428b45c3"
},
"invoice": {
"_invoice": {
"_id": "573f6b92f90e15ac1b8b4587",
"number": "A000000106"
}
},
"_deleted": false
},
{
"_id": "573f6d57f90e158e1d8b4569",
"actual": {
"manager": {
"start": "2016-05-10T10:00:00-04:00",
"verified_start": true,
"verified_start_date": "2016-05-20T16:02:31-04:00",
"verified_start_manager": "57360e77f90e15c27c8b4567",
"end": "2016-05-10T12:00:00-04:00",
"verified_end": true,
"verified_end_date": "2016-05-20T16:02:31-04:00",
"verified_end_manager": "57360e77f90e15c27c8b4567"
},
"start": "2016-05-10T10:00:00-04:00",
"end": "2016-05-10T12:00:00-04:00",
"duration": 7200,
"completed": "2016-05-20T16:02:31-04:00"
},
"pay": {
"start": "2016-05-10T10:00:00-04:00",
"end": "2016-05-10T12:00:00-04:00",
"duration": 3600,
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
}
},
"event": "573f6ad5f90e153e1d8b4579",
"_event": {
"duration": 7200,
"_deleted": false
},
"patient": {
"_patient": "53f6e8dd52b53fdb3100023c",
"name": {
"first": "Gabriella",
"last": "Gonzalez"
}
},
"location": {
"address": {
"street": "6440 Copper Falls Ave",
"city": "Thornhill"
}
},
"service": {
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"invoice_to": {
"type": "518bffa09c79e9cd0f2fbc82",
"client": {
"_id": "53f6b9590f0905a1240000f0",
"company": {
"name": {
"title": "State Farm Insurance"
}
}
}
}
},
"payroll": {
"_payroll": "5726f997f90e15f2428b45c3"
},
"invoice": {
"_invoice": {
"_id": "573f6b92f90e15ac1b8b4587",
"number": "A000000106"
}
},
"_deleted": false
},
{
"_id": "573f6dd0f90e15251e8b4574",
"actual": {
"manager": {
"start": "2016-05-05T10:00:00-04:00",
"verified_start": true,
"verified_start_date": "2016-05-20T16:04:32-04:00",
"verified_start_manager": "57360e77f90e15c27c8b4567",
"end": "2016-05-05T12:00:00-04:00",
"verified_end": true,
"verified_end_date": "2016-05-20T16:04:32-04:00",
"verified_end_manager": "57360e77f90e15c27c8b4567"
},
"start": "2016-05-05T10:00:00-04:00",
"end": "2016-05-05T12:00:00-04:00",
"duration": 7200,
"completed": "2016-05-20T16:04:32-04:00"
},
"pay": {
"start": "2016-05-05T10:00:00-04:00",
"end": "2016-05-05T12:00:00-04:00",
"duration": 3600,
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
}
},
"event": "573f6ad5f90e153e1d8b4578",
"_event": {
"duration": 7200,
"_deleted": false
},
"patient": {
"_patient": "53f6e8dd52b53fdb3100023c",
"name": {
"first": "Gabriella",
"last": "Gonzalez"
}
},
"location": {
"address": {
"street": "6440 Copper Falls Ave",
"city": "Thornhill"
}
},
"service": {
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"invoice_to": {
"type": "518bffa09c79e9cd0f2fbc82",
"client": {
"_id": "53f6b9590f0905a1240000f0",
"company": {
"name": {
"title": "State Farm Insurance"
}
}
}
}
},
"payroll": {
"_payroll": "5726f997f90e15f2428b45c3"
},
"invoice": {
"_invoice": {
"_id": "573f6b92f90e15ac1b8b4587",
"number": "A000000106"
}
},
"_deleted": false
},
{
"_id": "573f6e12f90e15381e8b4567",
"actual": {
"manager": {
"start": "2016-05-03T10:00:00-04:00",
"verified_start": true,
"verified_start_date": "2016-05-20T16:05:37-04:00",
"verified_start_manager": "57360e77f90e15c27c8b4567",
"end": "2016-05-03T12:00:00-04:00",
"verified_end": true,
"verified_end_date": "2016-05-20T16:05:37-04:00",
"verified_end_manager": "57360e77f90e15c27c8b4567"
},
"start": "2016-05-03T10:00:00-04:00",
"end": "2016-05-03T12:00:00-04:00",
"duration": 7200,
"completed": "2016-05-20T16:05:37-04:00"
},
"pay": {
"start": "2016-05-03T10:00:00-04:00",
"end": "2016-05-03T12:00:00-04:00",
"duration": 3600,
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
}
},
"event": "573f6ad5f90e153e1d8b4577",
"_event": {
"duration": 7200,
"_deleted": false
},
"patient": {
"_patient": "53f6e8dd52b53fdb3100023c",
"name": {
"first": "Gabriella",
"last": "Gonzalez"
}
},
"location": {
"address": {
"street": "6440 Copper Falls Ave",
"city": "Thornhill"
}
},
"service": {
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"invoice_to": {
"type": "518bffa09c79e9cd0f2fbc82",
"client": {
"_id": "53f6b9590f0905a1240000f0",
"company": {
"name": {
"title": "State Farm Insurance"
}
}
}
}
},
"payroll": {
"_payroll": "5726f997f90e15f2428b45c3"
},
"invoice": {
"_invoice": {
"_id": "573f6b92f90e15ac1b8b4587",
"number": "A000000106"
}
},
"_deleted": false
}
],
"_schema": "55b1224e599748249a5b334f",
"_created_date": "2016-05-20T15:54:57-04:00",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"ext_id": "6O0482C",
"accounting_id": "6O0482C",
"services": {
"57361206f90e15b07a8b4580": {
"service": "536f3444f518db6e5202a32c",
"pay_rate": {
"rate": 15,
"unit": "50ab5c594ef4ae57bda03025"
},
"_id": "57361206f90e15b07a8b4580",
"_key": 0
},
"573f18fef90e15f6178b4588": {
"service": "53a37d11056553f52d00000f",
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_id": "573f18fef90e15f6178b4588",
"_key": 1
},
"573f1934f90e15d3198b4573": {
"service": "536f3627f518db6e5202a32e",
"pay_rate": {
"rate": 31,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_id": "573f1934f90e15d3198b4573",
"_key": 2
}
}
},
"total": 14400,
"visits": 4,
"services": [
{
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"total": 14400
}
],
"name": "Jeanne Simmons",
"accounting_id": "1KC9KK0",
"user_services": {
"53f6b51795370f425b00007c": {
"service": "536f3444f518db6e5202a32c",
"pay_rate": {
"rate": 13.12,
"unit": "50ab5c594ef4ae57bda03025"
},
"_id": "53f6b51795370f425b00007c",
"_key": 0
},
"53f6b51e3fae5bfa78000084": {
"service": "53a37d11056553f52d00000f",
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_id": "53f6b51e3fae5bfa78000084",
"_key": 1
},
"53f6b5263fae5b667c000088": {
"service": "536f3627f518db6e5202a32e",
"pay_rate": {
"rate": 31,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_id": "53f6b5263fae5b667c000088",
"_key": 2
},
"54008f421c2c61517a8b4843": {
"service": "5398cbbdd6d01fec78000039",
"pay_rate": {
"rate": 44,
"unit": "50ab5c594ef4ae57bda03025"
},
"_id": "54008f421c2c61517a8b4843",
"_key": 3
}
}
}
Create payrolls
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit payrolls
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete payrolls
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get payroll
Gets the details of an existing payroll. Supply the unique payroll ID from either a payroll creation request or the payroll list, and Alaunus will return the corresponding payroll information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List payrolls
Returns a list of existing payrolls sent to third-party bank accounts or that Alaunus has sent you. The payrolls are returned in sorted order, with the most recently created payrolls appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Payrollsusers
The payrollsusers object
Attributes:
subdocuments
id
array
subdocument
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"totalPayrollUsersHours": 216060,
"totalPayrollUsersVisits": 45,
"payrollUsers": [
{
"_id": "573f69baf90e159a1b8b4599",
"user": {
"_user": "53f6b44595370fd468000058",
"name": {
"first": "Edith",
"last": "Peters"
},
"services": {
"574fd818f90e151d4d8b456a": {
"pay_rate": {
"rate": 13.12,
"unit": "50ab5c594ef4ae57bda03025"
},
"_service": "53f6b44f6396a0925300004e",
"account_service": "536f3444f518db6e5202a32c",
"code": "AC001",
"color": "#00aa00",
"label": "Attendant Care",
"_id": "574fd818f90e151d4d8b456a",
"_key": 0
},
"574fd818f90e151d4d8b456b": {
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_service": "54d10ee86cd75277628b4577",
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"label": "Registered Practical Nurse",
"_id": "574fd818f90e151d4d8b456b",
"_key": 1
},
"574fd818f90e151d4d8b456c": {
"pay_rate": {
"rate": 13,
"unit": "50ab5c594ef4ae57bda03025"
},
"_service": "54d10f603015ddbe0a8b48c5",
"account_service": "5400f203ab176cc61e000542",
"code": "THR",
"color": "#FBD75B",
"label": "Therapy Services",
"_id": "574fd818f90e151d4d8b456c",
"_key": 2
}
}
},
"total": 14400,
"visits": 4,
"services": [
{
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"total": 14400
}
],
"name": "Edith Peters",
"accounting_id": "JVPJ6K2"
},
{
"_id": "573f69f4f90e15e01b8b4581",
"user": {
"_user": "53f6b6f33fae5b667c0000bb",
"name": {
"first": "Marc",
"last": "Brooks"
},
"services": {
"574fd818f90e151d4d8b456d": {
"pay_rate": {
"rate": 31,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_service": "53f6b6fc3fae5bfa780000b2",
"account_service": "536f3627f518db6e5202a32e",
"code": "RN001",
"color": "#aa00aa",
"label": "Nursing",
"_id": "574fd818f90e151d4d8b456d",
"_key": 0
}
}
},
"total": 28800,
"visits": 8,
"services": [
{
"account_service": "536f3627f518db6e5202a32e",
"code": "RN001",
"color": "#aa00aa",
"total": 28800
}
],
"name": "Marc Brooks",
"accounting_id": "TUC9OUO"
},
{
"_id": "573f6bcbf90e15ec1b8b4580",
"user": {
"_user": "53f6b54995370f425b000082",
"name": {
"first": "Harry",
"last": "Knight"
},
"services": {
"574fd818f90e151d4d8b4571": {
"pay_rate": {
"rate": 13.12,
"unit": "50ab5c594ef4ae57bda03025"
},
"_service": "53f6b5523fae5bfa7800008b",
"account_service": "536f3444f518db6e5202a32c",
"code": "AC001",
"color": "#00aa00",
"label": "Attendant Care",
"_id": "574fd818f90e151d4d8b4571",
"_key": 0
}
}
},
"total": 54000,
"visits": 5,
"services": [
{
"account_service": "536f3444f518db6e5202a32c",
"code": "AC001",
"color": "#00aa00",
"total": 54000
}
],
"name": "Harry Knight",
"accounting_id": "8NATD0Y"
},
{
"_id": "573f6b91f90e15ac1b8b4584",
"user": {
"_user": "53f6b4a43fae5b667c000076",
"name": {
"first": "Jeanne",
"last": "Simmons"
},
"services": {
"574fd818f90e151d4d8b4575": {
"pay_rate": {
"rate": 13.12,
"unit": "50ab5c594ef4ae57bda03025"
},
"_service": "53f6b51795370f425b00007c",
"account_service": "536f3444f518db6e5202a32c",
"code": "AC001",
"color": "#00aa00",
"label": "Attendant Care",
"_id": "574fd818f90e151d4d8b4575",
"_key": 0
},
"574fd818f90e151d4d8b4576": {
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_service": "53f6b51e3fae5bfa78000084",
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"label": "Registered Practical Nurse",
"_id": "574fd818f90e151d4d8b4576",
"_key": 1
},
"574fd818f90e151d4d8b4577": {
"pay_rate": {
"rate": 31,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_service": "53f6b5263fae5b667c000088",
"account_service": "536f3627f518db6e5202a32e",
"code": "RN001",
"color": "#aa00aa",
"label": "Nursing",
"_id": "574fd818f90e151d4d8b4577",
"_key": 2
},
"574fd818f90e151d4d8b4578": {
"pay_rate": {
"rate": 44,
"unit": "50ab5c594ef4ae57bda03025"
},
"_service": "54008f421c2c61517a8b4843",
"account_service": "5398cbbdd6d01fec78000039",
"code": "RSW001",
"color": "#5484ED",
"label": "Medical Rehab",
"_id": "574fd818f90e151d4d8b4578",
"_key": 3
}
}
},
"total": 14400,
"visits": 4,
"services": [
{
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"total": 14400
}
],
"name": "Jeanne Simmons",
"accounting_id": "1KC9KK0"
},
{
"_id": "573f6b81f90e15111d8b456f",
"user": {
"_user": "53f6b74b6396a0d27200004b",
"name": {
"first": "Bernard",
"last": "Rodriguez"
},
"services": {
"574fd818f90e151d4d8b456e": {
"pay_rate": {
"rate": 13.5,
"unit": "50ab5c594ef4ae57bda03025"
},
"_service": "53f6b7536396a0d272000050",
"account_service": "536f3444f518db6e5202a32c",
"code": "AC001",
"color": "#00aa00",
"label": "Attendant Care",
"_id": "574fd818f90e151d4d8b456e",
"_key": 0
},
"574fd818f90e151d4d8b456f": {
"pay_rate": {
"rate": 17,
"unit": "50ab5c594ef4ae57bda03025"
},
"_service": "53f6b75a3fae5bfa780000bd",
"account_service": "5398cb8304fff5090c00002e",
"code": "HK001",
"color": "#FFB878",
"label": "Housekeeping",
"_id": "574fd818f90e151d4d8b456f",
"_key": 1
},
"574fd818f90e151d4d8b4570": {
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_service": "53f78c2252b53f9e38000575",
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"label": "Registered Practical Nurse",
"_id": "574fd818f90e151d4d8b4570",
"_key": 2
}
}
},
"total": 50400,
"visits": 14,
"services": [
{
"account_service": "536f3444f518db6e5202a32c",
"code": "AC001",
"color": "#00aa00",
"total": 28800
},
{
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"total": 21600
}
],
"name": "Bernard Rodriguez",
"accounting_id": "S1HII3J"
},
{
"_id": "573e318cf90e1588188b4568",
"user": {
"_user": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
},
"services": {
"574fd818f90e151d4d8b4572": {
"pay_rate": {
"rate": 15,
"unit": "50ab5c594ef4ae57bda03025"
},
"_service": "57361206f90e15b07a8b4580",
"account_service": "536f3444f518db6e5202a32c",
"code": "AC001",
"color": "#00aa00",
"label": "Attendant Care",
"_id": "574fd818f90e151d4d8b4572",
"_key": 0
},
"574fd818f90e151d4d8b4573": {
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_service": "573f18fef90e15f6178b4588",
"account_service": "53a37d11056553f52d00000f",
"code": "RPN001",
"color": "#00ccff",
"label": "Registered Practical Nurse",
"_id": "574fd818f90e151d4d8b4573",
"_key": 1
},
"574fd818f90e151d4d8b4574": {
"pay_rate": {
"rate": 31,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_service": "573f1934f90e15d3198b4573",
"account_service": "536f3627f518db6e5202a32e",
"code": "RN001",
"color": "#aa00aa",
"label": "Nursing",
"_id": "574fd818f90e151d4d8b4574",
"_key": 2
}
}
},
"total": 54060,
"visits": 10,
"services": [
{
"account_service": "536f3444f518db6e5202a32c",
"code": "AC001",
"color": "#00aa00",
"total": 54060
}
],
"name": "John Doe",
"accounting_id": "6O0482C"
}
],
"filteredPayrollUsersHours": 216060,
"filteredPayrollUsersVisits": 45
}
Create payrollsusers
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit payrollsusers
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete payrollsusers
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get payrollsuser
Gets the details of an existing payrollsuser. Supply the unique payrollsuser ID from either a payrollsuser creation request or the payrollsuser list, and Alaunus will return the corresponding payrollsuser information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List payrollsusers
Returns a list of existing payrollsusers sent to third-party bank accounts or that Alaunus has sent you. The payrollsusers are returned in sorted order, with the most recently created payrollsusers appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Punchcards
The punchcards object
Attributes:
subdocument
subdocument
subdocument
subdocument
id
subdocument
subdocument
subdocument
subdocument
subdocument
subdocument
subdocument
boolean
subdocument
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"_id": "573a20d3f90e15de078b4570",
"_created_user": {
"_id": "5679cdb609da69d90c8b4577",
"name": {
"first": "Isaac",
"last": "Romanov",
"title": "2e5c84ad927c053c8b7a7657"
}
},
"_last_updated_user": "5398bdb769aed1910a0000b1",
"patient": {
"_patient": {
"_id": "57360e2cf90e15a37b8b45de",
"chart_id": "R44RERF",
"name": {
"first": "Alex",
"last": "Snow",
"title": "2e5c84ad927c053c8b7a7657"
},
"date_of_birth": "1962-08-17",
"gender": "388057a478772ba4b477d1d7",
"general_notes": "Keys under carpet. Client needs...",
"phones": {
"57360e2cf90e15a37b8b45d1": {
"primary": true,
"country": "29f678bca33e6a07d9d61066",
"type": "4d781246adf865e9e117968b",
"notes": "Call after 5 p.m.",
"number": "+14056286752;ext=11",
"_id": "57360e2cf90e15a37b8b45d1",
"_created_user": "5679cdb609da69d90c8b4577",
"_key": 0
}
},
"locations": {
"57360e2cf90e15a37b8b45d2": {
"address": {
"country": "29f678bca33e6a07d9d61066",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"street": "12 Rosedale Ave",
"city": "Kitchener",
"zip": "N2H1J3",
"lat": 43.443177,
"lng": -80.4683897,
"map_img": "https://maps.google.com/maps/api/static..."
},
"primary": true,
"type": "235a44f0aafaf29a9695a9d3",
"_id": "57360e2cf90e15a37b8b45d2",
"_created_user": "5679cdb609da69d90c8b4577",
"_key": 0
}
},
"services": {
"57360e2cf90e15a37b8b45d6": {
"invoice_to": {
"type": "2f3b211669c6c8bc5903935e"
},
"take_highest_pay": true,
"treatment_date": "2016-02-07",
"service": "536f3444f518db6e5202a32c",
"bill_rate": {
"rate": 25,
"unit": "2c39fd62449c8da26b9b09ac"
},
"pay_rate": {
"rate": 15,
"unit": "50ab5c594ef4ae57bda03025"
},
"_id": "57360e2cf90e15a37b8b45d6",
"_created_user": "5679cdb609da69d90c8b4577",
"_deleted": true,
"_key": 0
},
"57b72e76563de14a3f8b456f": {
"invoice_to": {
"type": "518bffa09c79e9cd0f2fbc82",
"client": {
"_id": "53f6b931ccdf0519510000fe",
"contact_type": "537117bbf518db6e5202a33c",
"company": {
"name": {
"title": "TD General Insurance Company"
}
}
}
},
"take_highest_pay": true,
"service": "536f3444f518db6e5202a32c",
"bill_rate": {
"rate": 23.95,
"unit": "50ab5c594ef4ae57bda03025",
"taxes": {
"57b72e76563de14a3f8b456e": {
"tax": "536f3405f518db6e5202a32b",
"_id": "57b72e76563de14a3f8b456e",
"_created_user": "57360e77f90e15c27c8b4567"
}
}
},
"pay_rate": {
"rate": 13.75,
"unit": "50ab5c594ef4ae57bda03025"
},
"min_billable_hours": 2,
"max_billables": {
"month": {
"dollars": 5548.83
},
"contract": {
"dollars": 36000
}
},
"_id": "57b72e76563de14a3f8b456f",
"_created_user": "57360e77f90e15c27c8b4567",
"_key": 1
},
"57ead5e17e00025c088b456b": {
"invoice_to": {
"type": "2f3b211669c6c8bc5903935e"
},
"service": "536f3627f518db6e5202a32e",
"bill_rate": {
"rate": 150,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_id": "57ead5e17e00025c088b456b",
"_created_user": "57360e77f90e15c27c8b4567",
"_deleted": true,
"_key": 2
}
}
},
"name": {
"last": "Snow",
"first": "Alex"
},
"email": "test1@alaunus.com",
"legal_rep": "Ivan Boyko",
"general_notes": "Keys under carpet"
},
"service": {
"stat_holiday_multiplier": 1.5,
"_service": {
"invoice_to": {
"type": "2f3b211669c6c8bc5903935e"
},
"take_highest_pay": true,
"treatment_date": "2016-02-07",
"service": "536f3444f518db6e5202a32c",
"bill_rate": {
"rate": 25,
"unit": "2c39fd62449c8da26b9b09ac"
},
"pay_rate": {
"rate": 15,
"unit": "50ab5c594ef4ae57bda03025"
},
"_id": "57360e2cf90e15a37b8b45d6",
"_created_user": "5679cdb609da69d90c8b4577",
"_deleted": true,
"_key": 0
},
"account_service": "536f3444f518db6e5202a32c",
"color": "#00aa00",
"invoice_to": {
"type": "2f3b211669c6c8bc5903935e"
},
"bill_rate": {
"rate": 25,
"unit": "2c39fd62449c8da26b9b09ac"
},
"take_highest_pay": true,
"label": "Attendant Care",
"code": "AC001",
"pay_rate": {
"rate": 15,
"unit": "50ab5c594ef4ae57bda03025"
}
},
"_group": "573a20d3f90e15de078b456e",
"attendees": [
{
"user": {
"_user": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"name": {
"first": "John",
"last": "Doe"
},
"service": {
"account_service": "536f3444f518db6e5202a32c",
"pay_rate": {
"rate": 15,
"unit": "50ab5c594ef4ae57bda03025"
},
"_service": "57361206f90e15b07a8b4580"
}
},
"status": "a7f2da8ce2f36c258fb83d90",
"_id": "573a20d5f90e15de078b4589",
"_created_user": {
"_id": "5679cdb609da69d90c8b4577",
"name": {
"first": "Isaac",
"last": "Romanov",
"title": "2e5c84ad927c053c8b7a7657"
}
},
"punchcard": {
"_id": "573f6b69f90e154d1d8b4570",
"actual": {
"manager": {
"start": "2016-05-17T15:35:00-04:00",
"verified_start": true,
"verified_start_date": "2016-05-20T15:54:17-04:00",
"verified_start_manager": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"end": "2016-05-17T17:35:00-04:00",
"verified_end": true,
"verified_end_date": "2016-05-20T15:54:17-04:00",
"verified_end_manager": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
}
},
"start": "2016-05-17T15:35:00-04:00",
"end": "2016-05-17T17:35:00-04:00",
"duration": 7200,
"completed": "2016-05-20T15:54:17-04:00"
},
"bill": {
"start": "2016-05-17T15:35:00-04:00",
"end": "2016-05-17T17:35:00-04:00",
"duration": 3600,
"bill_rate": {
"rate": 25,
"unit": "2c39fd62449c8da26b9b09ac"
}
},
"pay": {
"start": "2016-05-17T15:35:00-04:00",
"end": "2016-05-17T17:35:00-04:00",
"duration": 7200,
"pay_rate": {
"rate": 15,
"unit": "50ab5c594ef4ae57bda03025"
}
},
"stat_holiday": false,
"payroll": {
"_payroll": {
"_id": "5726f997f90e15f2428b45c3",
"start": "2016-05-02",
"end": "2016-06-01"
},
"audit": {
"audited": true,
"audit_date": "2016-06-02T00:00:00-04:00"
},
"_removed": false
},
"invoice": {
"_invoice": {
"_id": "573f343af90e15011b8b4576",
"invoice_date": "2016-06-01",
"number": "A000000103"
},
"_removed": false
},
"_deleted": false
},
"_key": 0
}
],
"_schema": "55dcdc807862c370d5a76245",
"start": "2016-05-17T15:35:00-04:00",
"duration": 7200,
"status": "a7f2da8ce2f36c258fb83d90",
"_created_date": "2016-05-16T15:34:45-04:00",
"_last_updated_date": "2016-06-25T20:31:40-04:00",
"billing": {
"footer_message": "Thank you for your business. Please send...",
"_billing": "57360e2cf90e15a37b8b45d0",
"term": "536f311aaa78d2940c0000f7",
"invoice_type": "7e1a564dfadc3bd13b251d69",
"invoice_method": "35f16131a2aa09285decbb09",
"currency": "158fd9fea21be1043f5f3118",
"cc_invoice": {
"patient": false
},
"billing_period": {
"period": "f44aaeb99e21a2ea93134762",
"day": 1
},
"payment_method": "3bd8f8b09e49ee5ebc42eea5"
},
"_account": "53f6aa644d2de64fb30000af",
"location": {
"_location": {
"address": {
"country": "29f678bca33e6a07d9d61066",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"street": "12 Rosedale Ave",
"city": "Kitchener",
"zip": "N2H1J3",
"lat": 43.443177,
"lng": -80.4683897,
"map_img": "https://maps.google.com/maps/api/static..."
},
"primary": true,
"type": "235a44f0aafaf29a9695a9d3",
"_id": "57360e2cf90e15a37b8b45d2",
"_created_user": "5679cdb609da69d90c8b4577",
"_key": 0
},
"type": "235a44f0aafaf29a9695a9d3",
"address": {
"country": "29f678bca33e6a07d9d61066",
"state": "baa39fa80fb2f0bbf4d8cfdf",
"street": "12 Rosedale Ave",
"city": "Kitchener",
"zip": "N2H1J3",
"lat": 43.443177,
"lng": -80.4683897,
"map_img": "https://maps.google.com/maps/api/static..."
}
},
"end": "2016-05-17T17:35:00-04:00",
"stat_holiday": false,
"_deleted": false
}
Create punchcards
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit punchcards
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete punchcards
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get punchcard
Gets the details of an existing punchcard. Supply the unique punchcard ID from either a punchcard creation request or the punchcard list, and Alaunus will return the corresponding punchcard information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List punchcards
Returns a list of existing punchcards sent to third-party bank accounts or that Alaunus has sent you. The punchcards are returned in sorted order, with the most recently created punchcards appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Skills
The skills object
Attributes:
string
string
string
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"color": "blue",
"description": "Able to work with patients that have diabetes",
"tittle": "Diabetes"
}
Create skills
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit skills
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete skills
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get skill
Gets the details of an existing skill. Supply the unique skill ID from either a skill creation request or the skill list, and Alaunus will return the corresponding skill information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List skills
Returns a list of existing skills sent to third-party bank accounts or that Alaunus has sent you. The skills are returned in sorted order, with the most recently created skills appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Tags
The tags object
Attributes:
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"color": "blue",
"description": "Nursing",
"tittle": "RN00"
}
Create tags
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit tags
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete tags
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get tag
Gets the details of an existing tag. Supply the unique tag ID from either a tag creation request or the tag list, and Alaunus will return the corresponding tag information.
List tags
Returns a list of existing tags sent to third-party bank accounts or that Alaunus has sent you. The tags are returned in sorted order, with the most recently created tags appearing first.
Users
The users object
Attributes:
id
subdocuments
datetime
boolean
datetime
string
subdocument
subdocuments
boolean
string
date
string
subdocuments
subdocument
string
subdocuments
id
boolean
datetime
boolean
boolean
subdocuments
datetime
subdocuments
id
subdocument
string
subdocuments
file
id
id
subdocument
subdocuments
subdocuments
id
string
date
date
id
boolean
id
boolean
boolean
id
subdocument
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"_id": "53f6b74b6396a0d27200004b",
"ext_id": "S1HII3J",
"timezone": "1ba1a8c71d512573a97cb8d6",
"name": {
"first": "Bernard",
"last": "Rodriguez",
"title": "2e5c84ad927c053c8b7a7657"
},
"email": "bernard.rodriguez30@alaunus.com",
"start_date": "2014-08-21",
"photo": {
"_id": "53f6b74b6396a0d27200004a",
"name": "92.jpg"
},
"_created_date": "2014-08-21T23:21:47-04:00",
"is_setup": true,
"services": [
{
"service": {
"_id": "536f3444f518db6e5202a32c",
"code": "AC001",
"color": "#00aa00",
"label": "Attendant Care",
"bill_rate": {
"rate": 21.95,
"unit": "50ab5c594ef4ae57bda03025",
"taxes": [
{
"_id": "536f34e6f518db6e5202a32d",
"tax": "536f3405f518db6e5202a32b"
}
]
},
"pay_rate": {
"rate": 13.12,
"unit": "50ab5c594ef4ae57bda03025"
},
"_key": 0
},
"pay_rate": {
"rate": 13.5,
"unit": "50ab5c594ef4ae57bda03025"
},
"_id": "53f6b7536396a0d272000050",
"_created_user": "53a8701dd6c8df514f8b459d",
"held_since": "2015-11-08",
"rating": 4,
"_key": 0
},
{
"service": {
"color": "#FFB878",
"code": "HK001",
"label": "Housekeeping",
"bill_rate": {
"rate": 21.5,
"unit": "50ab5c594ef4ae57bda03025",
"taxes": [
{
"tax": "536f3405f518db6e5202a32b",
"_id": "5398cbc54b4eafb21e000038",
"_created_user": "5398bdb769aed1910a0000b1"
}
]
},
"pay_rate": {
"rate": 13,
"unit": "50ab5c594ef4ae57bda03025"
},
"_id": "5398cb8304fff5090c00002e",
"_created_user": "5398bdb769aed1910a0000b1",
"min_billable_hours": 2,
"_key": 2
},
"pay_rate": {
"rate": 17,
"unit": "50ab5c594ef4ae57bda03025"
},
"_id": "53f6b75a3fae5bfa780000bd",
"_created_user": "53a8701dd6c8df514f8b459d",
"held_since": "2016-05-15",
"rating": 2,
"_key": 1
},
{
"service": {
"color": "#00ccff",
"code": "RPN001",
"label": "Registered Practical Nurse",
"bill_rate": {
"rate": 41.2,
"unit": "2c39fd62449c8da26b9b09ac"
},
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
},
"_id": "53a37d11056553f52d00000f",
"_created_user": "5398bdb769aed1910a0000b1",
"_key": 4
},
"pay_rate": {
"rate": 32,
"unit": "2c39fd62449c8da26b9b09ac"
},
"held_since": "2014-08-03",
"rating": 5,
"_id": "53f78c2252b53f9e38000575",
"_created_user": "53a8701dd6c8df514f8b459d",
"_key": 2
}
],
"manager": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"accounting_id": "S1HII3J",
"_setup_date": "2014-08-22T12:19:34-04:00",
"languages": [
{
"primary": false,
"language": "23aec8cc02f681a6158f919d",
"fluency": "1cc5a6123c0bebd535e5a6ee",
"_id": "57597e9ff90e154f718b4572",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"_key": 0
},
{
"primary": false,
"language": "0abeb098607ced61942835a3",
"fluency": "2521a1856e750264c5645c2f",
"_id": "57597e9ff90e154f718b4573",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"_key": 1
},
{
"primary": true,
"language": "318722ea904dbe2ec1abc659",
"fluency": "1cc5a6123c0bebd535e5a6ee",
"_id": "57b71aae563de13e3f8b456a",
"_created_user": {
"_id": "57360e77f90e15c27c8b4567",
"name": {
"first": "John",
"last": "Doe"
}
},
"_key": 2
}
],
"living_status": "14063fd9ce471eb4a89e8efb",
"date_of_birth": "1985-04-07",
"ssn_expiry_date": "2020-08-25",
"gender": "388057a478772ba4b477d1d7",
"education_level": "86ed613f78fc346bc0f93c98",
"transportation": "576b0594efa3eedd9ff03687",
"experience_num_of_years": "576b0827efa3eedd9ff0368f",
"cooking_skill": "576b1eaaefa3eedd9ff036a3",
"cleaning_skill": "576b23b1efa3eedd9ff036aa",
"is_smoker": true,
"has_pets": true,
"type_of_pets": "576b1dc8efa3eedd9ff0369c",
"ssn": "789546154",
"criminal_offender": false,
"will_travel": false,
"travel_passport": false,
"us_visa": false,
"experience_with_ages": {
"age_0_months_3_months": false,
"age_3_months_1_year": false,
"age_1_year_3_years": false,
"age_3_years_6_years": false,
"age_6_years_10_years": false,
"age_10_years_15_years": false,
"age_15_years_more": false
},
"work_status": {
"full_time": false,
"part_time": false,
"temp": false,
"on_call": false
}
}
Create users
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit users
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete users
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get user
Gets the details of an existing user. Supply the unique user ID from either a user creation request or the user list, and Alaunus will return the corresponding user information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List users
Returns a list of existing users sent to third-party bank accounts or that Alaunus has sent you. The users are returned in sorted order, with the most recently created users appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
Usersnotes
The usersnotes object
Attributes:
datetime
string
id
string
id
curl 'http://example.com/api/test'
-H 'Authorization: key'
{
"_created_date": "05/05/1998",
"_created_user": "Mike",
"_deleted": false,
"last_updated_date": "05/05/1998",
"last_updated_user": "573f6b19f90e15ac1b8b4584",
"note": "Something crazy happened",
"priority": "357f6b19f90e15ac1b8b4584",
"title": "What happened",
"user": "766f6b19f90e15ac1b8b4584"
}
Create usersnotes
Iron Man is a 2008 American superhero film featuring the Marvel Comics character of the same name, produced by Marvel Studios and distributed by Paramount Pictures.1 It is the first film in the Marvel Cinematic Universe. The film was directed by Jon Favreau, with a screenplay by Mark Fergus and Hawk Ostby and Art Marcum and Matt Holloway. It stars Robert Downey Jr., Terrence Howard, Jeff Bridges, Shaun Toub and Gwyneth Paltrow. In Iron Man, Tony Stark, an industrialist and master engineer, builds a powered exoskeleton and becomes the technologically advanced superhero Iron Man.
Edit usersnotes
Doctor Strange is a 2016 American superhero film featuring the Marvel
Comics character of the same name, produced by Marvel Studios and distributed
by Walt Disney Studios Motion Pictures. It is the fourteenth film of the
Marvel Cinematic Universe (MCU). The film is directed by Scott Derrickson,
who wrote the film with Jon Spaihts and C. Robert Cargill, and stars Benedict
Cumberbatch, Chiwetel Ejiofor, Rachel McAdams, Benedict Wong, Michael Stuhlbarg,
Benjamin Bratt, Scott Adkins, Mads Mikkelsen, and Tilda Swinton. In Doctor
Strange, surgeon Stephen Strange learns the mystic arts from the Ancient One
after a career-ending car accident.
Various incarnations of a Doctor Strange film have been in development since
the mid-1980s until Paramount Pictures acquired the film rights in April 2005
on behalf of Marvel Studios. Thomas Dean Donnelly and Joshua Oppenheimer were
brought on board in June 2010 to write a screenplay. In June 2014, Derrickson
and Spaihts were hired to direct and re-write the film, respectively.
Cumberbatch was chosen for the eponymous role in December 2014, necessitating
a schedule change to work around his other commitments. This gave Derrickson
time to work on the script himself, for which he brought Cargill on to help.
The film began principal photography in November 2015 in Nepal before moving
to the United Kingdom, and concluded in New York City in April 2016. Filming
also occurred in Hong Kong.
Delete usersnotes
A Carreta Furacão é um grupo que viaja com o Trenzinho da Alegria, que é
uma carreta pintada, pelas ruas do Brasil mais especificamente de Ribeirão Preto,
e são os maiores causadores de acidentes, ao menos entre eles, já que sempre
um ou outro se machuca.
Eles fazem isso todos os dias. A Carreta Furacão é o Esquadrão Suicida brasileiro,
mas nem precisa de colar explosivo para alguém morrer. Em vez de Arlequina é o
Bozo, e até o Capitão América fazendo esse papel de guerrilheiro suicida devido
à crise nos Estados Unidos.
Get usersnote
Gets the details of an existing usersnote. Supply the unique usersnote ID from either a usersnote creation request or the usersnote list, and Alaunus will return the corresponding usersnote information.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
List usersnotes
Returns a list of existing usersnotes sent to third-party bank accounts or that Alaunus has sent you. The usersnotes are returned in sorted order, with the most recently created usersnotes appearing first.
true, false, "primary", "secondary"
- true returns objects
- false returns arrays
- primary returns documents as objects and subdocuments as arrays
- secondary returns documents in an array and subdocuments as objects
true, false, "primary", "secondary"
- true returns all archived and unarchived documents and subdocuments
- false prevents all archived documents/subdocuments from being returned
- primary returns all archived and unarchived documents and only unarchived subdocuments
- secondary returns only unarchived documents and all archived and unarchived subdocuments for those documents
true, false
non-negative integer
non-negative integer
comma separated fields
- note that fields within subdocument(s) can be specified using dot notation
- example: locations.address.city
- there are some fields that are always returned whether they're specified or not:
- _id
- subdocuments._id
- subdocuments._key
comma separated fields
{comma separated fields in the form "field":[1, -1]}
- in the given example we first sort by name.first, then by name.last
- 1 means sort ascending (A -> Z); -1 means sort descending (Z -> A)
array({"fields": array(array(comma separated fields)), "sort":[1, -1]})
- in the given example we first merge to get a strings in the form "contact.name.first contact.name.last" or "company.name.title", like "Jane Doe" or "Intact Insurance Company"
- then we sort the resulting strings either ascending or descending and return the result after sorting
array({"collection":collection, "function":value})
- you can specify zero or more of the following functions to execute on the embedded document:
- objects, archived, primary, fields, embeds
- within an embed, the archived function defaults its value to true and its value primary is disabled
- the primary function is currently broken
{comma separated queries}
datetime